<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="gkebackup_v1.html">Backup for GKE API</a> . <a href="gkebackup_v1.projects.html">projects</a> . <a href="gkebackup_v1.projects.locations.html">locations</a> . <a href="gkebackup_v1.projects.locations.backupChannels.html">backupChannels</a> . <a href="gkebackup_v1.projects.locations.backupChannels.backupPlanBindings.html">backupPlanBindings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve the details of a single BackupPlanBinding.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists BackupPlanBindings in a given location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Retrieve the details of a single BackupPlanBinding.

Args:
  name: string, Required. Fully qualified BackupPlanBinding name. Format: `projects/*/locations/*/backupChannels/*/backupPlanBindings/*` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.
  &quot;backupPlan&quot;: &quot;A String&quot;, # Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. `projects/*/locations/*/backupPlans/{backup_plan}`
  &quot;backupPlanDetails&quot;: { # Contains metadata about the backup plan/backup. # Output only. Contains details about the backup plan/backup.
    &quot;backupConfigDetails&quot;: { # BackupConfigDetails defines the configuration of Backups created via this BackupPlan. # Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.
      &quot;allNamespaces&quot;: True or False, # Output only. If True, include all namespaced resources
      &quot;encryptionKey&quot;: { # Defined a customer managed encryption key that will be used to encrypt Backup artifacts. # Output only. This defines a customer managed encryption key that will be used to encrypt the &quot;config&quot; portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
        &quot;gcpKmsEncryptionKey&quot;: &quot;A String&quot;, # Optional. Google Cloud KMS encryption key. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`
      },
      &quot;includeSecrets&quot;: True or False, # Output only. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
      &quot;includeVolumeData&quot;: True or False, # Output only. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
      &quot;selectedApplications&quot;: { # A list of namespaced Kubernetes resources. # Output only. If set, include just the resources referenced by the listed ProtectedApplications.
        &quot;namespacedNames&quot;: [ # Optional. A list of namespaced Kubernetes resources.
          { # A reference to a namespaced resource in Kubernetes.
            &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Kubernetes resource.
            &quot;namespace&quot;: &quot;A String&quot;, # Optional. The Namespace of the Kubernetes resource.
          },
        ],
      },
      &quot;selectedNamespaces&quot;: { # A list of Kubernetes Namespaces. # Output only. If set, include just the resources in the listed namespaces.
        &quot;namespaces&quot;: [ # Optional. A list of Kubernetes Namespaces.
          &quot;A String&quot;,
        ],
      },
    },
    &quot;lastSuccessfulBackup&quot;: &quot;A String&quot;, # Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/*/locations/*/backupPlans/*/backups/*`
    &quot;lastSuccessfulBackupTime&quot;: &quot;A String&quot;, # Output only. Completion time of the last successful Backup. This is sourced from a successful Backup&#x27;s complete_time field.
    &quot;nextScheduledBackupTime&quot;: &quot;A String&quot;, # Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.
    &quot;protectedPodCount&quot;: 42, # Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
    &quot;retentionPolicyDetails&quot;: { # RetentionPolicyDetails defines a Backup retention policy for a BackupPlan. # Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.
      &quot;backupDeleteLockDays&quot;: 42, # Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup&#x27;s (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
      &quot;backupRetainDays&quot;: 42, # Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value &gt;= 0 and &lt;= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Default: 0 (no automatic deletion)
    },
    &quot;rpoRiskLevel&quot;: 42, # Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
    &quot;state&quot;: &quot;A String&quot;, # Output only. State of the BackupPlan.
  },
  &quot;cluster&quot;: &quot;A String&quot;, # Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this binding was created.
  &quot;etag&quot;: &quot;A String&quot;, # Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the &#x27;etag&#x27; in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlanBinding`, and systems are expected to put that etag in the request to `UpdateBackupPlanBinding` or `DeleteBackupPlanBinding` to ensure that their change will be applied to the same version of the resource.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The fully qualified name of the BackupPlanBinding. `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`
  &quot;uid&quot;: &quot;A String&quot;, # Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this binding was created.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists BackupPlanBindings in a given location.

Args:
  parent: string, Required. The BackupChannel that contains the BackupPlanBindings to list. Format: `projects/*/locations/*/backupChannels/*` (required)
  filter: string, Optional. Field match expression used to filter the results.
  orderBy: string, Optional. Field by which to sort the results.
  pageSize: integer, Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response&#x27;s next_page_token to determine if there are more instances left to be queried.
  pageToken: string, Optional. The value of next_page_token received from a previous `ListBackupPlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlanBindings` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListBackupPlanBindings.
  &quot;backupPlanBindings&quot;: [ # The list of BackupPlanBindings matching the given criteria.
    { # A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.
      &quot;backupPlan&quot;: &quot;A String&quot;, # Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. `projects/*/locations/*/backupPlans/{backup_plan}`
      &quot;backupPlanDetails&quot;: { # Contains metadata about the backup plan/backup. # Output only. Contains details about the backup plan/backup.
        &quot;backupConfigDetails&quot;: { # BackupConfigDetails defines the configuration of Backups created via this BackupPlan. # Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.
          &quot;allNamespaces&quot;: True or False, # Output only. If True, include all namespaced resources
          &quot;encryptionKey&quot;: { # Defined a customer managed encryption key that will be used to encrypt Backup artifacts. # Output only. This defines a customer managed encryption key that will be used to encrypt the &quot;config&quot; portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
            &quot;gcpKmsEncryptionKey&quot;: &quot;A String&quot;, # Optional. Google Cloud KMS encryption key. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`
          },
          &quot;includeSecrets&quot;: True or False, # Output only. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
          &quot;includeVolumeData&quot;: True or False, # Output only. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
          &quot;selectedApplications&quot;: { # A list of namespaced Kubernetes resources. # Output only. If set, include just the resources referenced by the listed ProtectedApplications.
            &quot;namespacedNames&quot;: [ # Optional. A list of namespaced Kubernetes resources.
              { # A reference to a namespaced resource in Kubernetes.
                &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Kubernetes resource.
                &quot;namespace&quot;: &quot;A String&quot;, # Optional. The Namespace of the Kubernetes resource.
              },
            ],
          },
          &quot;selectedNamespaces&quot;: { # A list of Kubernetes Namespaces. # Output only. If set, include just the resources in the listed namespaces.
            &quot;namespaces&quot;: [ # Optional. A list of Kubernetes Namespaces.
              &quot;A String&quot;,
            ],
          },
        },
        &quot;lastSuccessfulBackup&quot;: &quot;A String&quot;, # Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/*/locations/*/backupPlans/*/backups/*`
        &quot;lastSuccessfulBackupTime&quot;: &quot;A String&quot;, # Output only. Completion time of the last successful Backup. This is sourced from a successful Backup&#x27;s complete_time field.
        &quot;nextScheduledBackupTime&quot;: &quot;A String&quot;, # Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.
        &quot;protectedPodCount&quot;: 42, # Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
        &quot;retentionPolicyDetails&quot;: { # RetentionPolicyDetails defines a Backup retention policy for a BackupPlan. # Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.
          &quot;backupDeleteLockDays&quot;: 42, # Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup&#x27;s (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
          &quot;backupRetainDays&quot;: 42, # Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value &gt;= 0 and &lt;= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Default: 0 (no automatic deletion)
        },
        &quot;rpoRiskLevel&quot;: 42, # Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
        &quot;state&quot;: &quot;A String&quot;, # Output only. State of the BackupPlan.
      },
      &quot;cluster&quot;: &quot;A String&quot;, # Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this binding was created.
      &quot;etag&quot;: &quot;A String&quot;, # Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the &#x27;etag&#x27; in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlanBinding`, and systems are expected to put that etag in the request to `UpdateBackupPlanBinding` or `DeleteBackupPlanBinding` to ensure that their change will be applied to the same version of the resource.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The fully qualified name of the BackupPlanBinding. `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`
      &quot;uid&quot;: &quot;A String&quot;, # Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this binding was created.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token which may be sent as page_token in a subsequent `ListBackupPlanBindingss` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>